Readme refactor #25
Open
Readme refactor #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 10 commits
December 20, 2015 14:56
It follows this rough outline:
1. Basic "what is this?" info.
2. Install the script.
3. Set up your project for the script.
4. Run the script.
- Options manual.
5. Configuration.
This tree of unordered-list-items could be further broken up into a table.
|
I haven't touched the "run" section yet, and I think it could still use a refresh. |
|
Also not completely happy on the formatting of things yet. I tried to balance legibility with length... too many layers of bullet-points isn't awesome... but I don't think it's there yet. Also some uncomfortable line-wrapping bits. |
|
This should include the full list of options in that can be set in the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #24